Send Money

POST /api/v1/Payments/send-money

Description

This endpoint is used to send money from one account to another.

Headers:

• No specific headers are required.

Path Parameters:

• version: The version of the API.

Request Body:

• transferRequest: Contains details of the money transfer, including the amount, sender and recipient details.

URL:

• POST: /api/v1/Payments/send-money

Response:

• 200: Success, returns a transaction ID indicating that the money transfer was successful.

Error Codes:

• 400: Bad request, the request body is not valid.

• 404: Not found, one or both of the accounts do not exist.

• 500: Internal server error, something went wrong while processing the request.

Example Request URL:

POST /api/v1.0/Payments/send-money
Content-Type: application/json
{
  "transferRequest": {
    "senderAccountId": "abc123",
    "recipientAccountId": "xyz789",
    "amount": 100.0,
    "description": "Payment for services"
  }
}

Example Response:

HTTP/1.1 200 OK
{
  "transactionId": "trxn123"
}

Notes:

• The response includes the transaction ID, which can be used to check the status of the transaction.

• This endpoint can be useful for making payments between accounts within the system.

Method: POST

/api/v1/Payments/send-money

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "reference": "<string>",
  "narration": "<string>",
  "amount": "<double>",
  "customerEmail": "<string>",
  "customerName": "<string>",
  "destinationType": 2,
  "currency": 1,
  "destination": {
    "bank": {
      "bankCode": "<string>",
      "accountNumber": "<string>"
    },
    "mobileMoney": {
      "operator": 2,
      "mobileNumber": "<string>"
    }
  }
}

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "amount": "<double>",
    "fee": "<double>",
    "currency": "<string>",
    "status": "<string>",
    "reference": "<string>",
    "clientReference": "<string>",
    "narration": "<string>",
    "trnxId": "<uuid>",
    "customer": {
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>"
    }
  }
}